8.6 查询代理网关节点区域
Path： /api/v1/nodeGroup/queryAll
Method： GET
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| withoutUnActivated | 必须 | 1 | 是否包含"未激活"区域。0为不包含，1为包含。建议填1。 |
请求示例
/api/v1/nodeGroup/queryAll?withoutUnActivated=1
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | number | 必须 | 0为成功，其他均为失败 | ||
| data | object | 必须 | |||
| ├─ data | object[] | 必须 | 区域节点信息 | ||
| ├─├─ children | object[] | 必须 | 区域节点信息列表 | ||
| ├─├─ id | string | 必须 | 区域节点id | ||
| ├─├─ name | string | 必须 | 区域节点名称 | ||
| ├─├─ addresses | object[] | 必须 | 接入地址配置 | ||
| ├─├─├─ lan | string[] | 非必须 | 局域网接入地址列表 | ||
| ├─├─├─ wan | string[] | 非必须 | 互联网接入地址列表 | ||
| msg | string | 必须 |
返回示例
{
"code": 0,
"data": {
"data": [
{
"children": [
{
"id": "331171d0-e14f-11ec-ae3b-b74c860ac9c0",
"name": "深圳",
"addresses": {
"lan": [
"1.1.1.1"
],
"wan": [
"2.2.2.2"
]
}
},
{
"id": "162a5d3c-2266-4643-9c50-c5e619fa7e6e",
"name": "Default",
"addresses": {
"lan": [
"3.3.3.3"
]
}
}
]
}
]
},
"msg": "请求成功"
}
错误信息
| 错误提示 | 错误码 |
|---|---|
| 参数检查出错 | 10000001 |
| 操作失败 | 10000000 |